﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

#pragma once
#include "GmFamilyService.h"
namespace gcmp
{
    class IDocument;
    class IParameterCustomData;
}
namespace gfam
{
    // \brief 族自定义参数解析器接口
    /// 
    /// 用户基于它派生，派生所在的模块需要写成插件机制；对应的插件放在sdk目录下的family_plugin_config文件夹中
    /// 插件初始化中对其通过解析器的管理器注册
    /// \see IFamilyCustomDataParameterParserManager
    class GM_FAMILY_SERVICE_EXPORT IFamilyCustomDataParameterParser
    {
    public:
        /// \brief 析构函数
        virtual ~IFamilyCustomDataParameterParser();

        /// \brief 解析自定义参数。
        ///
        /// \param pDocment 文档指针
        /// \param pParameterCustomObject 自定义参数对象
        /// \param pErrorMessage 错误信息
        /// \return true表示解析成功，false表示解析失败。
        virtual bool Parse(gcmp::IDocument* pDocment, const gcmp::IParameterCustomData* pParameterCustomObject, std::wstring* pErrorMessage) const = 0;
    };

} // end namespace gcmp
